/*
 * addon_command.h
 *
 *  Created on: 2010-1-7
 *      Author: gavinkwoe
 */

#ifndef ADDON_COMMAND_H_
#define ADDON_COMMAND_H_

#include "addon_features.h"
#include "addon_std.h"
#include "addon_struct.h"

/*************************************************************************
* COMMANDS
*************************************************************************/

/*
 * DESC:
 *	Open file
 * INPUT:
 *	(unsigned short *) args[0]	:	full path of target file in UNICODE
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_OPEN				"open"

/*
 * DESC:
 *	Repaint current page
 * INPUT:
 *	(addon_rect_ptr_t) args[0]:		pointer to bound rectangle
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_REPAINT			"repaint"

/*
 * DESC:
 *	Recalc page size...
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_RECALC			"recalc"

/*
 * DESC:
 *	Relayout paragraphs...
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_RELAYOUT			"relayout"

/*
 * DESC:
 *	Close file
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_CLOSE				"close"

/*
 * DESC:
 *	Set bound rect
 * INPUT:
 *	(addon_rect_ptr_t) args[0]:		pointer to bound rectangle
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_SET_BOUND_RECT	"set.bound_rc"

/*
 * DESC:
 *	Set paragraph setting and etc...
 * INPUT:
 *	(FAEX_REF(IObject)) args[0]:	pointer to setting object
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_SET_SETTING		"set.setting"

/*
 * DESC:
 *	Get reading percent
 * INPUT:
 *	(unsigned long *) args[0]:		pointer to precent
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_GET_POSITION		"get.position"

/*
 * DESC:
 *	Get paragraph of reading line
 * INPUT:
 *	none
 * OUTPUT:
 *	(addon_paragraf_ptr_t) result:	pointer to paragraph
 */
#define ADDON_CMD_GET_PARAGRAPH		"get.paragraph"

#define ADDON_CMD_GET_RESERVELINE	"set.ReserveLine"
/*
 * DESC:
 *	Get bookmark of reading line
 * INPUT:
 *	none
 * OUTPUT:
 *	(addon_bookmark_ptr_t) result:	pointer to bookmark
 */
#define ADDON_CMD_GET_BOOKMARK		"get.bookmark"

/*
 * DESC:
 *	Get preface of the book
 * INPUT:
 *	none
 * OUTPUT:
 *	(addon_preface_ptr_t) result:	pointer to preface
 */
#define ADDON_CMD_GET_PREFACE		"get.preface"

/*
 * DESC:
 *	Scroll up
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_SCROLL_UP			"scroll.up"

/*
 * DESC:
 *	Scroll down
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_SCROLL_DOWN		"scroll.down"

/*
 * DESC:
 *	Page up
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_PAGE_UP			"page.up"

/*
 * DESC:
 *	Page down
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_PAGE_DOWN			"page.down"

/*
 * DESC:
 *	Go to first page of the book
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_GOTO_TOP			"goto.top"

/*
 * DESC:
 *	Go to last page of the book
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_GOTO_BOTTOM		"goto.bottom"

#define ADDON_CMD_IS_TOP			"is.top" 

#define ADDON_CMD_IS_BOTTOM         "is.bottom"

/*
 * DESC:
 *	Go to percent of the book
 * INPUT:
 *	(unsigned long) args[0]:		percent
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_GOTO_POSITION		"goto.position"

/*
 * DESC:
 *	Go to the specific paragraph
 * INPUT:
 *	(addon_paragraf_ptr_t) args[0]:	paragraph
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_GOTO_PARAGRAPH	"goto.paragraph"

/*
 * DESC:
 *	Chapter search start
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_START_CHAPTER		"start.chap"

/*
 * DESC:
 *	Chapter search stop
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_STOP_CHAPTER		"stop.chap"

/*
 * DESC:
 *	Set chapter information
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_SET_CHAP_INFO		"set.chap_info"

/*
 * DESC:
 *	Get chapter information
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_GET_CHAP_INFO		"get.chap_info"

/*
 * DESC:
 *	Goto previous chapter 
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_PREV_CHAPTER		"prev.chap"

/*
 * DESC:
 *	Goto next chapter
 * INPUT:
 *	none
 * OUTPUT:
 *	none
 */
#define ADDON_CMD_NEXT_CHAPTER		"next.chap"

/*************************************************************************
* NOTIFICATIONS
*************************************************************************/

/*
 * DESC:
 *	Document was opened successfully
 */
#define ADDON_NTF_DOC_OPEN		"doc.open"

/*
 * DESC:
 *	Document was closed successfully
 */
#define ADDON_NTF_DOC_CLOSE		"doc.close"

/*
 * DESC:
 *	Exception
 */
#define ADDON_NTF_EXCEPTION		"exception"

/*
 * DESC:
 *	Read percent
 */
#define ADDON_NTF_READ_PERCENT	"page.percent"

/*
 * DESC:
 *	Chapter search begin
 */
#define ADDON_NTF_CHAP_START	"chap.start"

/*
 * DESC:
 *	Chapter search progress
 */
#define ADDON_NTF_CHAP_PROG		"chap.prog"

/*
 * DESC:
 *	Chapter search begin
 */
#define ADDON_NTF_CHAP_STOP		"chap.stop"

/*
 * DESC:
 *	Chapter search was done
 */
#define ADDON_NTF_CHAP_RESULT	"chap.result"

#endif /* ADDON_COMMAND_H_ */
